////////////////////////////////////////////////////////////////////////////////
//                                                                            //
//  Filename:    HydroHeat.h			                                      //
//  Developer:				                                                  //
//  Create date:			                                                  //
//                                                                            //
////////////////////////////////////////////////////////////////////////////////
//                                                                            //
//  Description: This is the class declaration for the slot gut of the        //
//               Australian Slot machine called Hydro Heat			          //
//                                                                            //
////////////////////////////////////////////////////////////////////////////////
//        2010 - Riplife Gaming.  All rights reserved.						  //
////////////////////////////////////////////////////////////////////////////////

#if !defined(__HYDROHEATGUTS_H__)
#define __HYDROHEATSGUTS_H__

#if _MSC_VER > 1000
#pragma once
#endif // _MSC_VER > 1000

#include "slotguts.h"
#include "getrand.h"

class HydroHeatGuts : public SlotGuts
{
public:
	HydroHeatGuts();

	virtual ~HydroHeatGuts();

private:
	// Shared enums between client and server
	#include "HydroHeatCommon.h"

	// Helpful lookup arrays.
	

	static SpinResult m_aScatterWinSpinResults[][6];

	static SpinResult lookupScatterWinSpinResult( uint8 nIconType, uint8 nCount )
	{
		if ( nIconType < NUM_VALID_ICONS && nCount < 6 )
		{
			return m_aScatterWinSpinResults[ nIconType ][ nCount ];
		}

		ASSERT( false );
		return EVT_INVALID;
	}

	// Helper functions for classifyScatters.
	void tryForJackpot( SlotSpin* spin );

	SpinResult getScatterWinResult( SlotSpin* spin, uint8 testIcon, int32& scatterPositions ) const;
	
	void evaluateScatterWin( SlotSpin* spin, SpinResult srScatterResult, int32 scatterPositions );

	void resetFreeSpinsValues();

	void evaluateFreeSpinsRace( SlotSpin* spin );
	void evaluateFreeSpinsEndRace( SlotSpin* spin );
	void setBoatPosition(int32 icon, int32 position, int32 multiplier);

	void setCustomSubgameDataServerOnly( bool8 ServerOnly );

protected:
	//virtual int32 getNumLinesBet();

public:
//	virtual void classifyStops( SpinLine* spinline, uint8* stops, uint8 bet, uint8 line,
//		uint8& rtnresult, uint8& multiplier );

/**
         * @brief Iterate the lines played and determine winners.
         * @param spin the slot spin.
         * @see classifyStops
         */
    virtual void classifyResult(SlotSpin *spin);

	virtual void classifyScatters( SlotSpin *spin );

    virtual bool8 isValidGuts();

    virtual void getGameModeMultiplierAndNoteId( uint8& nGameModeMultiplier, uint8& nNoteId );

	virtual bool8 processClientData( uint8 bonusGameType, int32 bonusDataCount, int32 *bonusData );

	virtual bool8 isBonusGameInProgress();

protected:
	// Override these framework functions.
	virtual void preSpinClassifyResults( SlotSpin* spin );
    virtual void postSpinClassifyResults( SlotSpin* spin );

	virtual bool8 hasSavedGames();

	virtual void Debug_SetLoserStops( uint8* pStops );

	int32 getProgressiveValue();

	void classifyAllPays( SlotSpin* spin );

};  


#endif // !defined(__HYDROHEATGUTS_H__)
